---
title: Howl Documentation (master branch)
---
%h1 Howl Documentation

.alert.alert-info
  %p
    This is the documentation for the master branch,
    documentation for older releases can be found here:
    %a.alert-link(href = "/versions/0.4/doc/") [Version 0.4]
    ,
    %a.alert-link(href = "/versions/0.3/doc/") [Version 0.3]
    ,

    Documentation is ever a ongoing work, and additional documentation
    will appear here as it is written. However, don't hesitate to
    %a.alert-link(href = "/contact.html") get in contact
    if you have any questions.


%h2#user-manual User manual

= hdr_link 1, 'Getting started', 'manual/getting-started.html'
= hdr_link 2, 'Configuring Howl', 'manual/configuration.html'
= hdr_link 3, 'Using Howl completions', 'manual/completions.html'
= hdr_link 4, 'Working with files', 'manual/files.html'
= hdr_link 5, 'Editing', 'manual/editing.html'
= hdr_link 6, 'Using multiple views', 'manual/views.html'
= hdr_link 7, 'Running external commands', 'manual/running_commands.html'
= hdr_link 8, "What's next?", 'manual/next.html'

%h2#api-reference API reference

.row
  - sliced_for_columns(3, howl_api_docs) do |col|
    .col-lg-4
      - col.each do |slice|
        %h3
          %small Module:
          = slice[:package]
        - slice[:docs].each do |doc|
          %h4
            = link_to doc.data[:title], doc.url

%h4 (.. WIP)

%h2#howl-specs Howl specs (tests)
%p
  Below are the Howl specs in HTML format. While the specs are certainly not
  complete, they are provided here in the hope that they may be useful for
  better understanding the API, as well as providing some code examples.
  Bundle specs are currently not included in the below list.

.row
  - sliced_for_columns(3, howl_specs) do |col|
    .col-lg-4
      - col.each do |slice|
        %h3
          %small Module:
          = slice[:package]
        - slice[:docs].each do |doc|
          %h4
            = link_to doc.data[:title], doc.url
